Cumulus OLE Automation Overview

For using Cumulus Automation Objects in applications supporting OLE Automation, please refer to the file "Cumulus.tlb", which is located in the application's directory. Please find below a list of the different currently supported objects.

Application

Catalog

CatalogingOptions

Catalogs

Categories

Category

FileFormatEntry

FileFormatTable

AssetReference

AssetReferences

LogEntries

LogEntry

Preferences

Record

Records

SelectedRecords

SelectedCategories

Server

ServerCatalog

ServerCatalogs

Status

StatusList

SubCategories


Name as String

This property returns the name of the application. This is the default property.

See also Application


Fullname as String

This property returns the full path of the application's executable.

See also Application


Application as Object

This property returns the application object.

See also Application


CatalogingOptions as Object

This property returns the Cataloging Options object.

See also Application


Catalogs as Object

This property returns the collection of the application's open catalogs.

See also Application


Parent as Object

This property returns the application's application object as parent

See also Application


Preferences as Object

This property returns the application's Preferences object.

See also Application


Visible as Boolean

This property returns or sets the application's visibilty.

See also Application


ConnectToServer (ServerName as String, User as String, Password as String) as Object

This method connects to the specified server as the given user using the password and returns the Server object on success.

See also Application


Quit

This method quits a running application.

See also Application


RestoreCatalog (BackupPathName as String, PathName as String [, WriteAccessPassword as String]) as Object

This method restores a catalog backup file, opens the created catalog using an optional write access password and returns the catalog object.

See also Application


FrontCatalog as Object

This property returns the application's frontmost catalog object.

See also Application


AllowSharing as Boolean (Administrator only)

This property returns or sets the catalog's sharing state.

See also Catalog


Application as Object

This property returns the application object.

See also Catalog


CanDeleteRecords as Boolean

This property returns the current permission for this catalog.

See also Catalog


CanModifyCategories as Boolean

This property returns the current permission for this catalog.

See also Catalog


CanModifyRecords as Boolean

This property returns the current permission for this catalog.

See also Catalog


CanModifyStatus as Boolean

This property returns the current permission for this catalog.

See also Catalog


CatalogServer as String

This property returns the catalog server's name, if the catalog is accessed as a client. For directly opened catalogs the returned string is empty.

See also Catalog


CategoriesVisible as Boolean

This property gets or sets the category visibility state of the catalog and shows or hides the category pane in a catalog window.

See also Catalog


Categories as Object

This property returns the categories of a catalog as list, sorted by name.

See also Catalog


SelectedCategories as Object

This property returns the catalog's category selection.

See also Catalog


CategoryTree as Object

This property returns the categories of a catalog as sub-tree structure. Using this property you can parse the categories of the catalog as a hierachical structured object. The sub-categories of this category tree are the top-level categories of the catalog.

See also Catalog


CollectionFolder as String

This property returns or sets the path of the catalog's collection folder.

See also Catalog


CollectionFolderUsage as Long (Administrator only)

This property returns the current collection folder usage value.

Possible values are:

Always	= 0

AsCatalogingOption	= 1

Never	= 2

See also CollectionFolderUsageConstants, Catalog


DiskSpaceAvailable as Long (Administrator only)

This property returns the available diskspace on the catalog's volume in bytes.

See also Catalog


FlushLogConstantely as Boolean (Administrator only)

This property returns or sets the option to flush the log file after every entry.

See also Catalog


FullName as String (Administrator only)

This property returns the full pathname of the catalog.

See also Catalog


HasPassword as Boolean

This property returns, if the catalog has a write access password.

See also Catalog


IsRemoteCatalog as Boolean

This property returns, if the catalog is opened as a client.

See also Catalog


KeepCategoryNamesUnique as Boolean (Administrator only)

This property returns or sets, if duplicate category names are allowed for this catalog.

See also Catalog


KeepDeleted as Boolean (Administrator only)

This property returns or sets, if deleted records should be kept for a later recovering or if they should be deleted permanentely.

See also Catalog


LogEntries as Object (Administrator only)

This property returns the catalog's log entries collection.

See also Catalog


LogFile as String (Administrator only)

This property returns or sets the log file for the catalog.

See also Catalog


Logging as Boolean (Administrator only)

This property returns or sets, if the catalog should switch logging on or off.

See also Catalog


LogLength as Long (Administrator only)

This property returns or sets the length of the memory log.

See also Catalog


MemoryAvailable as Long (Administrator only)

This property returns the available memory at the catalog's computer in Bytes.

See also Catalog


MemoryFree as Long (Administrator only)

This property returns the amount of free memory inside the catalog file in Bytes. This space can be reclaimed by compressing the catalog.

See also Catalog


MemoryRecommended as Long (Administrator only)

This property returns the amount of RAM in Bytes the catalog needs to run efficiently.

See also Catalog


MemoryRequired as Long (Administrator only)

This property returns the amount of RAM in Bytes the catalog needs to run.

See also Catalog


Name as String

This property returns the catalog's name. This is the default property.

See also Catalog


NativeThumbnailSize as Long (Administrator only)

This property reurns or sets the native thumbnails size in pixels of the catalog, which is used for cataloging assets.

Possible values are 96, 128 or 192.

See also Catalog


Parent as Object

This property returns the catalog's parent object.

See also Catalog


Query as String

This property returns or sets a catalog windows query in the Findbar. A query consists of the strings, that are available in the Findbar pulldown-menus or free definable strings for the operands. The single parts are divided by a "Tab" character, the query's conditions are divided by a "Return" character.

Example:

catalog.Query = "Record Name" & vbTab & "starts with" & vbTab & "0" & vbCr _

& "or" & vbTab & "Record Name" & vbTab & "contains" & vbTab & "8"

MsgBox catalog.Query

See also Catalog


Records as Object

This property returns the collection of records of a catalog.

See also Catalog


RecordsDeleted as Long (Administrator only)

This property returns the number of deleted records. These records can be reclaimed by calling RecoverDeletedRecords.

See also Catalog


SelectedCategories as Object

This property returns the category selection of a catalog.

See also Catalog


SelectedRecords as Object

This property returns the record selection of a catalog.

See also Catalog


RestrictedPermissions as Boolean (Administrator only)

This property returns or sets, if the catalog has restricted user permissions.

See also Catalog


SaveLogToFile as Boolean (Administrator only)

This property returns or sets, if the log should be saved to a file.

See also Catalog


SortDirection as Long

This property returns or sets the current sort direction of the catalog.

Possible values are:

Ascending	= 0

Descending	= 1

See also SortDirectionConstants, Catalog


Sorting as Long

This property returns or sets the current sorting of the catalog.

Possible values are:

ByName	= 0

ByFormat	= 1

ByColorMode	= 2

ByResolution	= 3

ByDate	= 4

See also SortingConstants, Catalog


UpdateCatalogImmediately as Boolean (Administrator only)

This property returns or sets, if the catalog's changes should be updated in the catalog file immediately (slower) or later (faster).

See also Catalog


UserPermissions as Object (Administrator only)

This property returns the catalog's user permissions collection.

See also Catalog


View as Long

This property returns the catalog's viewing type.

Possible values are:

Details	= 0

SmallThumbnails	= 1

MediumThumbnails	= 2

LargeThumbnails	= 3

Administration	= 4

See also ViewConstants, Catalog


Backup (PathName as String, FullBackup as Boolean) (Administrator only)

This method stores a backup copy of the catalog in the given file. If "FullBackup" is true, the catalog will be copied as a whole, otherwise only the record and category information is copied and the catalog needs to be restored before using it.

See also Catalog


Catalog (PathName as String)

This method catalogs the given file or folder.

See also Catalog


Compress (Administrator only)

This method compresses the catalog.

See also Catalog


Find (Query As String [ , Boolean InFindResult ] ) As Long

This method launches a search. If the given "Query" string is empty, the currently assigned query of the catalog will be taken. A query consists of the strings, that are available in the Findbar pulldown-menus or free definable strings for the operands. The single parts are divided by a "Tab" character, the query's conditions are divided by a "Return" character.

The optional Boolean "InFindResult" allows to define, if the search will use the previous search result or all records of the qatalog. If no parameter is passed to the function, the search is performed in all records.

Example:

query = "Record Name" & vbTab & "starts with" & vbTab & "0" & vbCr _

 	& "or" & vbTab & "Record Name" & vbTab & "contains" & vbTab & "8"

recordsFound = catalog.Find(query, False)

See also Catalog


ImportCategories (FromPathName as String)

This method imports categories from the given file.

See also Catalog


ImportRecords (FromPathName as String)

This method imports records from the given file.

See also Catalog


Rebuild (Administrator only)

This method repairs the catalog and rebuilds the indices.

See also Catalog


RecoverDeletedRecords (Administrator only)

This method recovers all deleted records from the catalog.

See also Catalog


ShowAllRecords

This method shows all records in the catalog's window, it reverses the effect of the Find method.

See also Catalog


StatusList as Object

This property returns the catalog's status list.

See also Catalog


PublishToWWW as Boolean

This property returns or sets, if the catalog is published to the World Wide Web.

See also Catalog


AddDuplicateAssets as Boolean

This property returns or sets, if duplicates of files should be cataloged or not.

See also CatalogingOptions


Application as Object

This property returns the application object.

See also CatalogingOptions


CatalogingAction as Long

This property returns or sets the action, that is used for the cataloging process.

Possible values are:

AddOnly	= 0

AddOrUpdate	= 1

UpdateOnly	= 2

See also CatalogingActionConstants, CatalogingOptions


Categories as List of String

This property returns or sets a list of preset categories.

See also CatalogingOptions


ColorThumbnailQuality as Long

This property returns or sets the thumbnail quality for creating color thumbnails.

Possible values are:

NormalQuality	= 0

HighQuality	= 1

See also ThumbnailQualityConstants, CatalogingOptions


CopyAssetToCollectionFolder as Boolean

This property returns or sets, if the file should be copied to the selection folder before cataloging or if the original file should be referenced.

See also CatalogingOptions


CountAssetsForProgress as Boolean

This property returns or sets, if the files of a folder or volume should be counted before cataloging to show a more detailed progress bar.

See also CatalogingOptions


ExcludeDamagedAssets as Boolean

This property returns or sets, if damaged assets that maybe cause Cumulus to crash should be added to the exclude asset list.

See also CatalogingOptions


ExcludedAssets as List of String

This property returns or sets a list of excluded asset, which will not be cataloged.

See also CatalogingOptions


FileFormatTable as Object

This property returns the file format table.

See also CatalogingOptions


GrayscaleThumbnailQuality as Long

This property returns or sets the thumbnail quality for creating grayscale thumbnails.

Possible values are:

NormalQuality	= 0

HighQuality	= 1

See also ThumbnailQualityConstants, CatalogingOptions


IncludeCategoriesFromAsset as Boolean

This property returns or sets, if categories contained in an asset should be added to the catalog and the created record.

See also CatalogingOptions


IncludeFolderNamesAsCategories as Boolean

This property returns or sets, if the folder structure of cataloged files should be created as categories and if the parent folder's category should be added to the created record.

See also CatalogingOptions


IncludeNotesFromAsset as Boolean

This property returns or sets, if notes contained in an asset should be added to the created record.

See also CatalogingOptions


LineartThumbnailQuality as Long

This property returns or sets the thumbnail quality for creating lineart thumbnails.

Possible values are:

NormalQuality	= 0

HighQuality	= 1

See also ThumbnailQualityConstants, CatalogingOptions


Notes as String

This property returns or sets the preset notes for cataloging.

See also CatalogingOptions


OpenPropertyWindow as Boolean

This property returns or sets, if after cataloging a new asset the property window should be opened automatically to allow immediate editing.

See also CatalogingOptions


OptimizeThumbnailsAutomatically as Boolean

This property returns or sets, if the thumbnails should be automatically optimized in brightness and contrast during cataloging.

See also CatalogingOptions


Parent as Object

This property returns the cataloging option's parent object.

See also CatalogingOptions


ResolveShortcuts as Boolean

This property returns or sets, if shortcuts should be resolved or ignored during cataloging.

See also CatalogingOptions


Status as String

This property returns or sets the preset status.

See also CatalogingOptions


ThumbnailSource as Long

This property returns or sets the wanted source for the created thumbnails.

Possible values are:

FromStoredThumbnail	= 0

FromEntireAsset	= 1

See also ThumbnailSourceConstants, CatalogingOptions


User as String

This property returns or sets the preset user for cataloging.

See also CatalogingOptions


Application as Object

This property returns the application object.

See also Catalogs


Count as Long

This property returns the number of catalogs in the collection.

See also Catalogs


Parent as Object

This property returns the catalogs' parent object.

See also Catalogs


Add (Pathname as String [,WriteAccessPassword as String]) as Object

This method allows to open a catalog file using an optional write access password and returns the catalog object (Desktop PLUS only).

See also Catalogs


Item (Index as Long / Name as String) as Object

This property returns a collection's catalog by index or by name. This is the default property.

See also Catalogs


Remove (Index as Long / Name as String)

This method closes a catalog of the collection (by index or by name).

See also Catalogs


New (Pathname as String, [CatalogName as String]) as Object

This method creates a new catalog file, opens it and returns the catalog object. The catalog name is optional, the file name willl be taken as default.

See also Catalogs


Application as Object

This property returns the application object.

See also Categories


Count as Long

This property returns the number of categories of the catalog.

See also Categories


Parent as Object

This property returns the categories' parent object.

See also Categories


Add as Object

This method adds a new category on the top level of a Cumulus catalog using the default category name and returns the newly created category object.

See also Categories


AddCopy (Category as Object) as Object

This method copies a category including all sub-categories and original categories on the top level of a Cumulus catalog and returns the newly created category object.

See also Categories


Item (Index as Long / Name as String) as Object

This property returns a category by index or by name. This is the default property.

See also Categories


ItemByID (ID as Long) as Object

This property returns a category by category ID.

See also Categories


Remove (Index as Long / Name as String)

This method removes a category from a Cumulus catalog by index or by name.

See also Categories


Export (Path as string)

Export exports a Cumulus catalog's categories. If the export file does not exist it is created.

See also Categories


Application as Object

This property returns the application object.

See also Category


Collapsed as Boolean

This property returns or sets the collapsed state of the category in the user interface.

See also Category


Directory as String

This property returns or sets a directory category's path.

See also Category


ID as Long

This property returns the category's internal ID.

See also Category


Level as Long

This property returns the category's level in the category tree.

See also Category


Name as String

This property returns or sets the category's name. This is the default property.

See also Category


Original as Object

This property returns or sets a related category's original category.

See also Category


Parent as Object

This property returns the category's parent object.

See also Category


ParentCategory as Object

This property returns or sets the category's parent category. The value "Nothing" means top level category.

See also Category


SubCategories as Object

This property returns the collection of sub-categories of the category.

See also Category


Type as Long

This property returns or sets the type of a category.

Possible values are:

NormalCategory	= 0

RelatedCategory	= 1 (read only)

DirectoryCategory	= 2

See also CategoryTypeConstants, Category


Export (Path as string)

Export exports a single category. If the export file does not exist it is created.

See also Category


Application as Object

This property returns the application object.

See also FileFormatEntry


DefaultBitmap as String

This property returns or sets the default bitmap, which is taken, if no thumbnail could be created for the file during cataloging.

See also FileFormatEntry


Extension as String

This property returns or sets the extension of the file format entries supported file format.

See also FileFormatEntry


FileFormat as String

This property returns or sets the file format string of the file format entry.

See also FileFormatEntry


IsActive as Boolean

This property returns or sets, if the file format entry is activated or inactive.

See also FileFormatEntry


Name as String

This property returns or sets the file format entries control name, for example "Canto Generic Filter". This is the default property.

See also FileFormatEntry


Parent as Object

This property returns the file format entries parent object.

See also FileFormatEntry


Application as Object

This property returns the application object.

See also FileFormatTable


Count as Long

This property returns the number of installed file format entries.

See also FileFormatTable


Add (Name as String [, AsIndex as Long]) as Object

This method adds a file format entry of the given filter control name (for example "Canto Generic Filter"). If the optional parameter AsIndex is set, it will be inserted there, otherwise at position 0. The newly created file format entry object will be returned.

See also FileFormatTable


Item (Index as Long / Name as String) as Object

This property returns a file format entry by index or by name. If the name consists only of the extension, the first matching file format entry will be returned, if the name consists of extension plus divider plus the filter control name, the specified entry will be returned. The divider can be one of the following characters ` ',`:' or `-'. This is the default property.

Example:

dim filter as object

set filter = theApp.CatalogingOptions.FileFormatTable ("bmp:Canto Wang Filter", 4)

See also FileFormatTable


Parent as Object

This property returns the file format entries parent object.

See also FileFormatTable


Remove (Index as Long / Name as String)

This property removes a file format entry by index or by name. If the name consists only of the extension, the first matching file format entry will be removed, if the name consists of extension plus divider plus the filter control name, the specified entry will be removed. The divider can be one of the following characters ` ',`:' or `-'.

Example:

theApp.CatalogingOptions.FileFormatTable.Remove ("bmp:Canto Wang Filter")

See also FileFormatTable


Application as Object

This property returns the application object.

See also AssetReference


Parent as Object

This property returns the file reference's parent object.

See also AssetReference


Text as String

This property returns the file reference's path name as string. This is the default property.

See also AssetReference


Type as String

This property returns the file reference's type as string.

It can be "MacOS" or "Windows" in the current version.

See also AssetReference


Application as Object

This property returns the application object.

See also AssetReferences


Parent as Object

This property returns the file references' parent object.

See also AssetReferences


Count as Long

This property returns the count of different file references for different platforms.

See also AssetReferences


Item (Index as Long / Name as String) as Object

This property returns a file reference by index or by name.

The name can be "MacOS" or "Windows" in the current version. This is the default property.

See also AssetReferences


Update (PathName as String)

This method updates the file references with the given path.

See also AssetReferences


Application as Object

This property returns the application object.

See also LogEntries


Count as Long

This property returns the number of log entries.

See also LogEntries


Parent as Object

This property returns the log entries' parent object.

See also LogEntries


Clear

This method clears the memory log of the catalog.

See also LogEntries


Save (Pathname as String)

This method saves the log to a text file. If the catalog's option "SaveLogToFile" is activated, the whole log file is saved as text file, otherwise only the memory log entries are stored.

See also LogEntries


Item (Index as Long) as Object

This property returns a log entry by.Index. This is the default property.

See also LogEntries


Action as String

This propery returns a string describing the protocolled action like "Catalog opened".

See also LogEntry


Application as Object

This property returns the application object.

See also LogEntry


Date as Date

This property returns the log entries time stamp.

See also LogEntry


Name as String

This property returns the log entries user name. This is the default property.

See also LogEntry


Object as String

This property returns the log entries additional information object, for example record name or category name.

See also LogEntry


Parent as Object

This property returns the log entries parent object.

See also LogEntry


Application as Object

This property returns the application object.

See also PathMapping


FromPath As String

This property returns or sets the path, that should be mapped.

See also PathMapping


Parent as Object

This property returns the path mappings parent object.

See also PathMapping


ToPath as String

This property returns or sets the path, the FromPath should be mapped to.

See also PathMapping


Application as Object

This property returns the application object.

See also PathMappings


Count as Long

This property returns the number of entries in the path mapping table.

See also PathMappings


Parent as Object

This property returns the path mappings' parent object.

See also PathMappings


Add (FromPath as String, ToPath as String) as Object

This method adds a new entry to the path mapping table using the given FromPath and ToPath strings and returns the newly created path mapping object.

See also PathMappings


Item (Index as Long / FromPath as String) as Object

This property returns a path mapping object by index or by FromPath. This is the default property.

See also PathMappings


Remove (Index as Long / FromPath as String)

This method removes a path mapping object from the table using an index or the FromPath string

See also PathMappings


Application as Object

This property returns the application object.

See also Preferences


ManualPreviewSize as Long

This property returns or sets the preview size in pixels if

 "ManualPreviewSize" is chosen as default preview size.

See also Preferences


OpenAtStartup as Boolean

This property returns or sets, if catalogs should be reopened at application start.

See also Preferences


OpenCatalogView as Long

This property returns or sets the startup view of a catalog.

Possible values are:

AdministrationView	= 0

ThumbnailView	= 1

TextView	= 2

AsClosed	= 3

See also CatalogViewConstants, Preferences


Parent as Object

This property returns the preferences' parent object.

See also Preferences


PathMappings as Object

This property returns the path mappings object.

See also Preferences


PreviewSize as Long

This property returns or sets the default size for opening preview windows.

Possible values are:

OriginalPreviewSize	= 0

MaximumPreviewSize	= 1

ManualPreviewSize	= 2

See also PreviewSizeConstants, Preferences


ResolveRelatedCategories as Boolean

This property returns or sets, if related categories should be resolved for searching.

See also Preferences


SearchForCategoriesAbove as Boolean

This property returns or sets, if the category search should also find categories above.

See also Preferences


SearchForCategoriesBelow as Boolean

This property returns or sets, if the category search should also find categories below.

See also Preferences


SearchAllSelectedCategories as Boolean

this property returns or sets, if the category search should find records containing all categories or at least one.

See also Preferences


ShowTooltips as Boolean

This property returns or sets, if tooltips should be shown in thumbnail view.

See also Preferences


ShowWarnings as Boolean

This property returns or sets, if warnings should be shown.

See also Preferences


ThumbnailSimilarityThreshold (0 To 1) as Long

This property returns or sets, how the similarity search will find records. The default values are {10, 30}. Use smaller values to do a narrower search.

See also Preferences


Units as Long

This property returns or sets the display unit.

Possible values are:

Inch	= 0

Centimeter	= 1

Millimeter	= 2

Point	= 3

Pixel	= 4

Pica	= 5

See also UnitConstants, Preferences


UseGrid as Boolean

This property returns or sets, if a grid should be used for resizing catalog windows.

See also Preferences


UsePathMapping as Boolean

This property returns or sets, if the pathmapping table should be used for resolving file references.

See also Preferences


WindowToOpenOnDoubleClick as Long

This property returns or sets, which window kind should be

opened on double clicking a record.

Possible values are:

PropertyWindow	= 0

PreviewWindow	= 1

See also OnDoubleClickConstants, Preferences


Application as Object

This property returns the application object.

See also Record


Categories as Object

This property returns the collection of the record's assigned categories.

See also Record


ColorMode as Long

This property returns or sets the record's color mode.

Possible values are:

Lineart	= 0

Grayscale	= 1

Color	= 2

See also ColorModeConstants, Record


Deletable as Boolean

This property returns or sets the record's possibility to be deleted.

See also Record


AssetCreationDate as Date

This property returns or sets the record's asset creation date.

See also Record


AssetDataSize as Date

This property returns or sets the asset file's data fork's size.

See also Record


FileFormat as String

This property returns or sets the record's file format.

See also Record


AssetModificationDate as Date

This property returns or sets the record's asset modification date.

See also Record


AssetReferences

This property returns the asset file's file references for the different platforms.

See also Record


AssetRsrcSize as Long

This property returns or sets the asset file's resource fork's size.

See also Record


AssetSize as Long

This property returns the asset file's size (AssetDataSize plus AssetRsrcSize).

See also Record


Height as Double

This property returns or sets the asset file's height in inches.

See also Record


HorizontalResolution as Double

This property returns or sets the asset file's horizontal resolution.

See also Record


ID as Long

This property returns the record's internal ID.

See also Record


MacCreator as String

This property returns or sets the record's Macintosh Creator Type (4 characters).

See also Record


MacFileType as String

This property returns or sets the record's Macintosh File Type (4 characters).

See also Record


Asset as String

This property returns or sets the record's file display path (unresolved).

See also Record


Modifiable as Boolean

This property returns or sets the record's possibility to be modified.

See also Record


Name as String

This property returns or sets the record's name. This is the default property.

See also Record


Notes as String

This property returns or sets the record's notes.

See also Record


Parent as Object

This property returns the record's parent object.

See also Record


RecordCreationDate as Date

This property returns or sets the record's creation date.

See also Record


RecordModificationDate as Date

This property returns or sets the record's modification date.

See also Record


Software as String

This property returns or sets the asset file's creating software.

See also Record


Status as Object

This property returns and sets the record's status.

To set the status of a record please use the following syntax:

set record.status = newStatus

Without "set" the name (default property) of the referenced status will be changed.

See also Record


TypeSpecific as String

This property returns or sets the record's type specific information as hex string.

See also Record


User as String

This property returns or sets the record's user name.

See also Record


VerticalResolution as Double

This property returns or sets the asset file's vertical resolution.

See also Record


Width as Double

This property returns or sets the asset file's width in inches.

See also Record


UpdateAssetReference

This method checks and updates the record's asset file's file reference, if the resolver modules can resolve the reference without showing a dialog.

See also Record


CopyAsset (ToPathName as String)

This method copies the record's asset file to the given folder path.

See also Record


CopyThumbnail

This method copies the record's thumbnail to the clipboard.

See also Record


Delete

This method deletes the record from the catalog.

See also Record


Deselect

This method removes the record from the catalog's record selection.

See also Record


Export (ToPathName as String)

Export exports the record's information. If the export file does not exist it is created.

See also Record


MoveAsset (ToPathName as String)

This method moves the record's asset file to the given folder path and updates the record's asset file reference.

See also Record


ShowPreviewWindow

This method shows the record's asset file's preview window in the application frame.

See also Record


OptimizeThumbnail

This method tries to optimize the record's thumbnail.

See also Record


PasteThumbnail

This method replaces the record's thumbnail with a bitmap from the clipboard.

See also Record


RotateThumbnail (ByDegrees as Long)

This method rotates the thumbnail by the given amount of degrees. The parameter must be a multiple of 90.

See also Record


Select

This method adds the record to the catalog's record selection.

See also Record


ShowPropertiesWindow

This methode shows the record's properties window.

See also Record


Update ( [Always as Boolean])

This method updates the record if necessary. If the optional parameter "Always" is set to "True", it will be updated in any case.

See also Record


Application as Object

This property returns the application object.

See also Records


Count as Long

This property returns the collection's number of records.

See also Records


Parent as Object

This property returns the records' parent object.

See also Records


Add as Object

This method creates a new empty record (for testing purposes mainly) and returns the newly created record object.

See also Records


AddCopy (Record as Object)

This method copies a record from another catalog to this one and returns the newly created record object.

See also Records


Item (Index as Long / Name as String) as Object

This property returns a collection's record by index or by name. This is the default property.

See also Records


ItemByID (ID as Long)

This property returns a record by record ID.

See also Records


Remove (Index as Long / Name as String)

This method removes a record from the catalog by index or by name. If a name is given which specifies more than one record only the first one is deleted.

See also Records


RemoveByID (ID as Long)

This method removes a record from the catalog by record ID.

See also Records


Export (ToPathName as String)

Export exports the information of all records. If the export file does not exist it is created.

See also Records


Application as Object

This property returns the application object.

See also SelectedCategories


Count as Long

This property returns the number of selected categories of a Cumulus catalog or categories of a record.

See also SelectedCategories


Parent as Object

This property returns the selected categories' parent object.

See also SelectedCategories


Add (Category as Object)

This method adds a category to the catalog's category selection or to the categories assigned to a record and returns the category object.

See also SelectedCategories


Item (Index as Long / Name as String) as Object

This property returns a selected category by index or by name. This is the default property.

See also SelectedCategories


ItemByID (ID as Long) as Object

This property returns a selected category by category ID.

See also SelectedCategories


Remove (Index as Long / Name as String)

This method removes a category from the catalog's category selection or from a record by index or by name.

See also SelectedCategories


RemoveByID (ID as Long)

This method removes a category from the catalog's category selection or from a record by category ID.

See also SelectedCategories


Export (Path as string)

Export exports a a Cumulus catalog's selected categories or a record's assigned categories. If the export file does not exist it is created.

See also SelectedCategories


Application as Object

This property returns the application object.

See also SelectedRecords


Count as Long

This property returns the number of selected records of a Cumulus catalog.

See also SelectedRecords


Parent as Object

This property returns the selected record's parent object.

See also SelectedRecords


Add (Record as Object)

This method adds a record to the catalog's record selection and returns the record object.

See also SelectedRecords


Item (Index as Long / Name as String) as Object

This property returns a selected record by index or by name. This is the default property.

See also SelectedRecords


ItemByID (ID as Long) as Object

This property returns a selected record by record ID.

See also SelectedRecords


Remove (Index as Long / Name as String)

This method removes a record from the catalog's record selection by index or by name. If a name is given which specifies more than one record only the first one is deselected.

See also SelectedRecords


RemoveByID (ID as Long)

This method removes a record from the catalog's record selection by record ID.

See also SelectedRecords


Export  (ToPathName as String)

Export exports the record's information of all selected records. If the export file does not exist it is created.

See also SelectedRecords


Application as Object

This property returns the application object.

See also Server


Parent as Object

This property returns the server's parent object.

See also Server


IsAdministrator as Boolean

This property returns if the current connection to the server is an administrator's connection.

See also Server


Name as String

This property returns the server's name.

 See also Server


Catalogs as Object

This property returns the server's collection of open catalogs.

See also Server


Application as Object

This property returns the application object.

See also ServerCatalog


Parent as Object

This property returns the server catalog's parent object.

See also ServerCatalog


Name as String

This property returns a remote catalog's name. This is the default property.

See also ServerCatalog


ID as Long

This property returns a remote catalog's ID.

See also ServerCatalog


IsShared as Boolean

This property returns a remote catalog's sharing state.

See also ServerCatalog


Open as Object

This method opens a remote catalog at the server and returns the remote catalog's catalog object.

See also ServerCatalog


Application as Object

This property returns the application object.

See also ServerCatalogs


Count as Long

This property returns the collection's count of open remote catalogs.

See also ServerCatalogs


Parent as Object

This property returns the server catalog collection's parent object.

See also ServerCatalogs


Add (Pathname as String [, WriteAccessPassword as String]) as Object

This method adds an existing catalog to the server's catalog list using an optional write access password and returns the server catalog.

See also ServerCatalogs


Item (Index as Long / Name as String) as Object

This property returns a collection's server catalog by index or by name. This is the default property.

See also ServerCatalogs


ItemByID (ID as Long) as Object

This property returns a collection's server catalog by the server catalog's ID.

See also ServerCatalogs


New (Pathname as String, [CatalogName as String]) as Object

This method creates a new catalog at the server, adds it to the server's catalog list and returns the server catalog. The catalog name is optional, the file name willl be taken as default.

See also ServerCatalogs


Remove (Index as Long / Name as String)

This property removes a server catalog from the collection by index or by name.

See also ServerCatalogs


RemoveByID (ID as Long)

This property removes a server catalog from the collection by the catalog's id.

See also ServerCatalogs


Restore (BackupPathName as String, PathName as String [, WriteAccessPassword as String]) as Object

This method restores a catalog backup file "BackupPathName" and creates a new catalog "PathName" at the server using an optional write access password, adds it to the server's catalog list and returns the server catalog.

See also ServerCatalogs


Application as Object

This property returns the application object.

See also Status


ID as Long

This property returns the status' internal ID.

See also Status


Name as String

This property returns the status' name. This is the default property.

See also Status


Parent as Object

This property returns the status' parent object.

See also Status


Application as Object

This property returns the application object.

See also StatusList


Count as Long

This property returns the number of the catalog's status.

See also StatusList


Parent as Object

This property returns the status list's parent object.

See also StatusList


Add (Name as String, AsIndex as Long) as Object

This method inserts a status in the catalog's status list using the given name and index and returns the status object.

See also StatusList


Item (Index as Long / Name as String) as Object

This property returns a status by index or by name. This is the default property.

See also StatusList


ItemByID (ID as Long) as Object

This property returns a status by status ID.

See also StatusList


Remove (Index as Long / Name as String)

This method removes a status from the catalog's status list by index or by name.

See also StatusList


RemoveByID (ID as Long)

This method removes a status from the catalog's status list by status ID.

See also StatusList


Application as Object

This property returns the application object.

See also SubCategories


Count as Long

This property returns the number of sub-categories in the collection.

See also SubCategories


Parent as Object

This property returns the sub-categories' parent object.

See also SubCategories


Add as Object

This method adds a new category to the sub-categories collection using the default category name and returns the category object.

See also SubCategories


AddCopy (Category as Object) as Object

This method copies a category including all sub-categories and original categories to the sub-categories collection and returns the category object.

See also SubCategories


Item (Index as Long / Name as String) as Object

This property returns a category by index or by name. This is the default property.

See also SubCategories


Remove (Index as Long / Name as String)

This method removes a category from the sub-categories collection by index or by name.

See also SubCategories


Application as Object

This property returns the application object.

See also UserPermission


CanDeleteRecords as Boolean

This property returns or sets, if the user is allowed to delete records in the catalog.

See also UserPermission


CanModifyCategories as Boolean

This property returns or sets, if the user is allowed to modify the category list (adding, changing or deleting categories).

See also UserPermission


CanModifyRecords as Boolean

This property returns or sets, if the user is allowed to modify records.

See also UserPermission


CanModifyStatus as Boolean

This property returns or sets, if the user is allowed to modify the status list by adding, changing or deleting a status.

See also UserPermission


CanOpenCatalog as Boolean

This property returns or sets, if the user is allowed to open the catalog.

See also UserPermission


Name as String

This property returns or sets the user's name of the user permission. This is the default property.

See also UserPermission


Parent as Object

This property returns the user permission's parent object.

See also UserPermission


Application as Object

This property returns the application object.

See also UserPermissions


Count as Long

This property returns the number of user permissions.

See also UserPermissions


Parent as Object

This property returns the user permissions' parent object.

See also UserPermissions


Add (Name as String) as Object

This method adds a new user permission to the user permission collection using the given name and returns the user permission object.

See also UserPermissions


Item (Index as Long / Name as String) as Object

This property returns a user permission by index or by user name. This is the default property.

See also UserPermissions


Remove (Index as Long / Name as String)

This method removes a user permission from the user permission collection by index or by user name.

See also UserPermissions


ColorModeConstants

These constants describe a record's color mode.

Possible values are:

Lineart	= 0,

Grayscale	= 1

Color	= 2


Application Object

This is the Cumulus Application object.

Application

CatalogingOptions

Catalogs

ConnectToServer

FrontCatalog

Fullname

Name

Parent

Preferences

RestoreCatalog

Visible

Quit

See also Overview


Catalog Object

The catalog object allows you to access an open Cumulus catalog.

AllowSharing

Application

Backup

CanDeleteRecords

CanModifyCategories

CanModifyRecords

CanModifyStatus

Catalog

CatalogServer

Categories

CategoriesVisible

CategoryTree

CollectionFolder

CollectionFolderUsage

Compress

DiskSpaceAvailable

Find

FlushLogConstantly

FullName

HasPassword

ImportCategories

ImportRecords

IsRemoteCatalog

KeepCategoryNamesUnique

KeepDeleted

LogEntries

LogFile

Logging

LogLength

MemoryAvailable

MemoryFree

MemoryRecommended

MemoryRequired

Name

NativeThumbnailSize

Parent

PublishToWWW

Query

Rebuild

RecoverDeletedRecords

Records

RecordsDeleted

RestrictedPermissions

SaveLogToFile

ShowAllRecords

SelectedCategories

SelectedRecords

SortDirection

Sorting

StatusList

UpdateCatalogImmediately

UserPermissions

View

See also Overview


Catalogs Collection

The Catalogs Collection is a collection containing Catalog objects.

Add

Application

Count

Item

New

Parent

Remove

See also Overview


Record Object

The Record Object represents a single record of a Cumulus catalog and allows access to the single record members.

Application

Asset

AssetCreationDate

AssetDataSize

AssetModificationDate

AssetReferences

AssetRsrcSize

AssetSize

Categories

ColorMode

CopyAsset

CopyThumbnail

Delete

Deletable

Deselect

Export

FileFormat

Height

HorizontalResolution

ID

MacCreator

MacFileType

Modifiable

MoveAsset

Name

Notes

OptimizeThumbnail

Parent

PasteThumbnail

RecordCreationDate

RecordModificationDate

RotateThumbnail

Select

ShowPreviewWindow

ShowPropertiesWindow

Software

Status

TypeSpecific

Update

UpdateAssetReference

User

VerticalResolution

Width

See also Overview


Records Collection

The Records Collection is a collection containing Record objects.

Add

AddCopy

Application

Count

Export

Item

ItemByID

Parent

Remove

RemoveByID

See also Overview


Server Object

The server object allows connecting to a remote server and administrate or work with it.

Application

Catalogs

IsAdministrator

Name

Parent

See also Overview


ServerCatalog Object

The ServerCatalog object allows you to access an open remote Cumulus catalog.

Application

ID

IsShared

Name

Open

Parent

See also Overview


ServerCatalogs Collection

The ServerCatalogs Collection is a collection containing ServerCatalog objects.

Add

Application

Count

Item

ItemByID

New

Parent

Remove

RemoveByID

Restore

See also Overview


SelectedRecords Collection

The SelectedRecords Collection is a collection containing the catalog's selected records.

Add

Application

Count

Export

Item

ItemByID

Parent

Remove

RemoveByID

See also Overview


Categories Collection

The Categories Collection is a collection containing the catalog's categories as a list sorted by name.

Add

AddCopy

Application

Count

Export

Item

ItemByID

Parent

Remove

See also Overview


Category Object

The Category object allows you to access a single Category of a Cumulus catalog.

Application

Collapsed

Directory

Export

ID

Level

Name

Original

Parent

ParentCategory

SubCategories

Type

See also Overview


SubCategories Collection

The SubCategories Collection is a collection containing a categories sub-categories.

Add

AddCopy

Application

Count

Item

Parent

Remove

See also Overview


SelectedCategories Collection

The SelectedCategories Collection is a collection containing a catalog's category selection or a records's assigned categories.

Add

Application

Count

Export

Item

ItemByID

Parent

Remove

RemoveByID

See also Overview


StatusList Object

The StatusList object allows you to access the status list of a Cumulus catalog.

Add

Application

Count

Item

ItemByID

Parent

Remove

RemoveByID

See also Overview


AssetReferences Collection

The AssetReferences Collection allows you to access the single asset references for different platforms of a record.

Application

Count

Item

Parent

Update

See also Overview


AssetReference Object

The AssetReference Object allows you to access a single asset reference for a specific platform.

Application

Parent

Text

Type

See also Overview


CatalogingOptions Object

The CatalogingOptions object allows you to access the cataloging options of Cumulus.

AddDuplicateAssets

Application

CatalogingAction

Categories

ColorThumbnailQuality

CopyAssetToCollectionFolder

CountAssetsForProgress

ExcludeDamagedAssets

ExcludedAssets

FileFormatTable

GrayscaleThumbnailQuality

IncludeCategoriesFromAsset

IncludeFolderNamesAsCategories

IncludeNotesFromAsset

LineartThumbnailQuality

Notes

OpenPropertyWindow

OptimizeThumbnailAutomatically

Parent

ResolveShortcuts

Status

ThumbnailSource

User

See also Overview


Preferences

The Preferences object allows you to access the application preferences of Cumulus.

Application

ManualPreviewSize

OpenAtStartup

OpenCatalogView

Parent

PathMappings

PreviewSize

ResolveRelatedCategories

SearchAllSelectedCategories

SearchForCategoriesAbove

SearchForCategoriesBelow

ShowTooltips

ShowWarnings

ThumbnailSimilarityThreshold

Units

UseGrid

UsePathMapping

WindowToOpenOnDoubleClick

See also Overview


Status Object

The Status object allows you to access a single status of the catalog's status list or a record.

Application

ID

Name

Parent

See also Overview


UserPermission Object

The UserPermission object allows you to access a single user permission of the catalog.

Application

CanDeleteRecords

CanModifyCategories

CanModifyRecords

CanModifyStatus

CanOpenCatalog

Name

Parent

See also Overview


UserPermissions Collection

The UserPermissions Collection allows you to access the user permissions of a catalog.

Add

Application

Count

Item

Parent

Remove

See also Overview


FileFormatEntry Object

The FileFormatEntry object allows you to access a single file format entry.

Application

DefaultBitmap

Extension

FileFormat

IsActive

Name

Parent

See also Overview


FileFormatTable Collection

The FileFormatTable Collection allows you to access the file format entries.

Add

Application

Count

Item

Parent

Remove

See also Overview


LogEntry Object

The LogEntry Object allows you to access a single log entry.

Action

Application

Date

Name

Object

Parent

See also Overview


LogEntries Collection

The LogEntries Collection allows you to access a catalog's log entries.

Application

Clear

Count

Item

Parent

Save

See also Overview


PathMapping Object

The PathMapping Object allows you to access a single path mapping entry.

Application

FromPath

Parent

ToPath

See also Overview


PathMappings Collection

The PathMappings Collection allows you to access the application's path mapping table.

Application

Count

Parent

Add

Item

Remove

See also Overview


CategoryTypeConstants

These constants describe the type of a category.

Possible values are:

NormalCategory	= 0

RelatedCategory	= 1

DirectoryCategory	= 2


CollectionFolderUsageConstants

These constants describe the type of the collection folder's usage.

Possible values are:

Always	= 0

AsCatalogingOption	= 1

Never	= 2


SortDirectionConstants

These constants describe catalog's sort direction.

Possible values are:

Ascending	= 0

Descending	= 1


SortingConstants

These constants describe catalog's sorting type.

Possible values are:

ByName	= 0

ByFormat	= 1

ByColorMode	= 2

ByResolution	= 3

ByDate	= 4


ViewConstants

These constants describe catalog's viewing type.

Possible values are:

Details	= 0

SmallThumbnails	= 1

MediumThumbnails	= 2

LargeThumbnails	= 3

Administration	= 4


ThumbnailQualityConstants

These constants describe the thumbnail quality for creating thumbnails.

Possible values are:

NormalQuality	= 0

HighQuality	= 1


ThumbnailSourceConstants

These constants describe the wanted source for created thumbnails.

Possible values are:

FromStoredThumbnail	= 0

FromEntireAsset	= 1


CatalogingActionConstants

These constants describe the action, that is used for the cataloging process.

Possible values are:

AddOnly	= 0

AddOrUpdate	= 1

UpdateOnly	= 2


CatalogViewConstants

These constants describe the startup view of a catalog.

Possible values are:

AdministrationView	= 0

ThumbnailView	= 1

TextView	= 2

AsClosed	= 3


PreviewSizeConstants

These constants describe the default size for opening preview windows.

Possible values are:

OriginalPreviewSize	= 0

MaximumPreviewSize	= 1

ManualPreviewSize	= 2


UnitConstants

These constants describe the display unit.

Possible values are:

Inch	= 0

Centimeter	= 1

Millimeter	= 2

Point	= 3

Pixel	= 4

Pica	= 5


OpenOnDoubleClickConstants

These constants describe, which window kind should be opened on double clicking a record.

Possible values are:

PropertyWindow	= 0

PreviewWindow	= 1